Interface TelephonyService

All Superinterfaces:
IPCObject
All Known Implementing Classes:
TelephonyServiceImpl

public interface TelephonyService extends IPCObject
Information provided by the PKI file:

    \class CTelephonyService
    
    \brief CTelephonyService handles and manipulates telephony services.
    
    \example network().getDevice("Router0").getProcess("CMEProcess").getTelephonyService()
    
Author:
Auto-generated
  • Method Details

    • setAutoRegistration

      void setAutoRegistration(boolean bVal)
      Information provided by the PKI file:
      
          \brief Enables or disables auto registration.
          
          \param bVal, true to enable auto registration.
          
              
      Parameters:
      bVal - Takes in a parameter of bVal
    • isAutoRegEnabled

      boolean isAutoRegEnabled()
      Information provided by the PKI file:
      
          \brief Returns true if auto registration is enabled, otherwise false.
          
          \return bool, true if auto registration is enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • setMaxEphone

      void setMaxEphone(int maxEphNum)
      Information provided by the PKI file:
      
          \brief Sets the maximum number of ephones.
          
          \param maxEphNum, the maximum number of ephones.
          
              
      Parameters:
      maxEphNum - Takes in a parameter of maxEphNum
    • getMaxEphoneNumber

      int getMaxEphoneNumber()
      Information provided by the PKI file:
      
          \brief Returns the maximum number of ephones.
          
          \return int, the maximum number of ephones.
          
              
      Returns:
      int Returns a int
    • setMaxDnNumber

      void setMaxDnNumber(int maxDnNum)
      Information provided by the PKI file:
      
          \brief Sets the maximum number of directory numbers.
          
          \param maxDnNum, the maximum number of directory numbers.
          
              
      Parameters:
      maxDnNum - Takes in a parameter of maxDnNum
    • getMaxDnNumber

      int getMaxDnNumber()
      Information provided by the PKI file:
      
          \brief Returns the maximum number of directory numbers.
          
          \return int, the maximum number of directory numbers.
          
              
      Returns:
      int Returns a int
    • setSourcePort

      void setSourcePort(int portNum)
      Information provided by the PKI file:
      
          \brief Sets the source port number.
          
          \param portNum, the source port number.
          
              
      Parameters:
      portNum - Takes in a parameter of portNum
    • getSourcePort

      int getSourcePort()
      Information provided by the PKI file:
      
          \brief Returns the source port number.
          
          \return int, the source port number.
          
              
      Returns:
      int Returns a int
    • setSystemMessage

      void setSystemMessage(String msg)
      Information provided by the PKI file:
      
          \brief Sets the system message.
          
          \param msg, the system message.
          
              
      Parameters:
      msg - Takes in a parameter of msg
    • setAutoAssign

      void setAutoAssign(int startTag, int stopTag)
      Information provided by the PKI file:
      
          \brief Sets the auto assign directory numbers.
          
          \param startTag, the start directory numbers.
          \param stopTag, the stop directory numbers.
          
              
      Parameters:
      startTag - Takes in a parameter of startTag
      stopTag - Takes in a parameter of stopTag
    • getAutoAssignCount

      int getAutoAssignCount()
      Information provided by the PKI file:
      
          \brief Returns the number of auto assigned directory numbers.
          
          \return int, the number of auto assigned directory numbers.
          
              
      Returns:
      int Returns a int
    • getAutoAssignStartDnAt

      int getAutoAssignStartDnAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the auto assigned start directory number at the specified index.
          
          \param index, the index of the auto assigned start directory number of interest.
          
          \returns int, the auto assigned start directory number at the specified index.
          
              
      Parameters:
      index - Takes in a parameter of index
      Returns:
      int Returns a int
    • getAutoAssignStopDnAt

      int getAutoAssignStopDnAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the auto assigned stop directory number at the specified index.
          
          \param index, the index of the auto assigned stop directory number of interest.
          
          \returns int, the auto assigned stop directory number at the specified index.
          
              
      Parameters:
      index - Takes in a parameter of index
      Returns:
      int Returns a int